Redact query string values for http client spans by jeanbisutti · Pull Request #13114 · open-telemetry/opentelemetry-java-instrumentation

jeanbisutti · 2025-01-27T14:02:11Z

See https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md

jeanbisutti · 2025-01-27T15:14:59Z

...ava/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractorTest.java

+          arguments("https://github.com#t@st.html", "https://github.com#t@st.html"),
+          arguments("user1:secret@github.com", "user1:secret@github.com"),
+          arguments("https://github.com@", "https://github.com@"),
+          arguments(


This test was (probably inadvertly) removed in #9925.

The test is added again with new test cases.

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java

...c/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/CommonConfig.java

...try/instrumentation/api/incubator/builder/internal/DefaultHttpClientInstrumenterBuilder.java

...mentation/api/incubator/semconv/http/HttpClientExperimentalHttpParamsRedactionExtractor.java

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java

laurit · 2025-02-13T15:32:52Z

semantic conventions define the same redactions for url.query in http server spans

trask · 2025-02-13T15:36:22Z

I think it's ok to scope this PR to http client spans since that's the primary issue in Java at least (update the title, the config option is already scoped to http clients)

jeanbisutti · 2025-02-13T16:36:51Z

semantic conventions define the same redactions for url.query in http server spans

I have created #13292

… other experimental options

…tion/api/semconv/http/HttpClientAttributesExtractor.java Co-authored-by: Lauri Tulmin <tulmin@gmail.com>

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java

jeanbisutti · 2025-02-24T10:23:24Z

@trask Does it seem good for you?

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java

…tion/api/semconv/http/HttpClientAttributesExtractor.java

Co-authored-by: Steve Rao <raozihao.rzh@alibaba-inc.com> Co-authored-by: Lauri Tulmin <tulmin@gmail.com> Co-authored-by: Lauri Tulmin <ltulmin@splunk.com> Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

jeanbisutti requested a review from a team as a code owner January 27, 2025 14:02

jeanbisutti marked this pull request as draft January 27, 2025 14:02

jeanbisutti force-pushed the redact-query-string-values branch 2 times, most recently from aba2207 to 608bc78 Compare January 27, 2025 14:43

jeanbisutti commented Jan 27, 2025

View reviewed changes

jeanbisutti marked this pull request as ready for review January 27, 2025 15:18

jeanbisutti force-pushed the redact-query-string-values branch 2 times, most recently from d8d8dc3 to c95b161 Compare January 27, 2025 16:57

jaydeluca reviewed Jan 27, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Show resolved Hide resolved

steverao reviewed Jan 28, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

steverao reviewed Jan 28, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Show resolved Hide resolved

steverao reviewed Jan 29, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

steverao reviewed Jan 29, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

steverao approved these changes Jan 30, 2025

View reviewed changes

laurit reviewed Jan 30, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

laurit reviewed Jan 30, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

laurit reviewed Jan 30, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

laurit reviewed Jan 30, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Show resolved Hide resolved

trask added this to the v2.13.0 milestone Feb 10, 2025

github-actions bot added the test native This label can be applied to PRs to trigger them to run native tests label Feb 11, 2025

jeanbisutti requested a review from laurit February 11, 2025 15:55

laurit reviewed Feb 12, 2025

View reviewed changes

...c/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/CommonConfig.java Outdated Show resolved Hide resolved

laurit reviewed Feb 12, 2025

View reviewed changes

...try/instrumentation/api/incubator/builder/internal/DefaultHttpClientInstrumenterBuilder.java Outdated Show resolved Hide resolved

laurit reviewed Feb 12, 2025

View reviewed changes

...mentation/api/incubator/semconv/http/HttpClientExperimentalHttpParamsRedactionExtractor.java Outdated Show resolved Hide resolved

trask reviewed Feb 13, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

jeanbisutti mentioned this pull request Feb 13, 2025

Redact query string values of http server spans #13292

Closed

jeanbisutti changed the title ~~Redact query string values~~ Redact query string values for http client spans Feb 13, 2025

jeanbisutti and others added 13 commits February 17, 2025 14:37

Move configuration from the stable API

65f0a33

Only use HttpClientAttributesExtractor and rename configuration

951b0f4

Fix JSON metadata

febf108

Fix Spring metadata

53a7a0b

Enable query redaction by default and clean up

be63270

Instance variable set to true to avoid confusion

da85a5e

Re-apply feedback

fa98de3

make experimental option setting for redacted query params similar to…

4fc1c2d

… other experimental options

Re-apply feedback

dd05fbb

Simplify

a5760ba

Update instrumentation-api/src/main/java/io/opentelemetry/instrumenta…

f37ab6d

…tion/api/semconv/http/HttpClientAttributesExtractor.java Co-authored-by: Lauri Tulmin <tulmin@gmail.com>

test method naming

9ef64ab

merge

4911e83

jeanbisutti force-pushed the redact-query-string-values branch from f9a1d63 to 4911e83 Compare February 17, 2025 13:40

Add scenarios with parameters without values

5164fe5

jeanbisutti force-pushed the redact-query-string-values branch from edcdb3a to 5164fe5 Compare February 18, 2025 16:44

laurit reviewed Feb 20, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

laurit reviewed Feb 20, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

laurit reviewed Feb 20, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Show resolved Hide resolved

laurit approved these changes Feb 20, 2025

View reviewed changes

Alternative version

ef736e1

laurit reviewed Feb 25, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

fix typo

bbed3b3

trask reviewed Feb 27, 2025

View reviewed changes

...in/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractor.java Outdated Show resolved Hide resolved

Update instrumentation-api/src/main/java/io/opentelemetry/instrumenta…

1f20468

…tion/api/semconv/http/HttpClientAttributesExtractor.java

trask enabled auto-merge (squash) February 27, 2025 15:34

spotless

0195b2a

trask merged commit 5b287e3 into open-telemetry:main Feb 27, 2025
61 checks passed

Conversation

jeanbisutti commented Jan 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeanbisutti Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

laurit commented Feb 13, 2025

Uh oh!

trask commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeanbisutti commented Feb 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeanbisutti commented Feb 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jeanbisutti commented Jan 27, 2025 •

edited

Loading

trask commented Feb 13, 2025 •

edited

Loading